2020.1

Itential Automation Platform

On this page:

Installation to Add Adapter

Installation to Add Adapter to IAP (Optional)

IAP uses network and OSS adapters to facilitate the integration of IAP with various systems and applications.

In order to add a new adapter to IAP, the adapter module must be installed under node_modules within the IAP installation directory.

npm Package

The following steps demonstrate installing the adapter, from the npm registry and in its package form.

cd /opt/pronghorn/current

# Install "latest".
npm install @itentialopensource/adapter-db_mongo

# Install, or upgrade, a specific version.
npm install @itentialopensource/adapter-db_mongo@1.2.3

Source

Alternatively, an adapter may be installed from source.

cd /opt/pronghorn/current/node_modules/@itential
git clone git@gitlab.com:itentialopensource/adapters/persistence/adapter-db_mongo
cd adapter-db_mongo
npm ci

When you must upgrade, or change versions of an adapter, perform the following steps.

cd /opt/pronghorn/current/node_modules/@itential/adapter-db_mongo
git checkout master
git pull

# If you need to see a list of all the tags/version numbers: `git tag`.

git checkout <your desired version number>
git pull
rm -rf node_modules
npm ci

Once the adapter module is installed, restart IAP and the adapter will be auto-discovered during IAP startup and become available when adding an adapter via the IAP UI.

The following steps will add an available adapter to IAP.

  1. Access the IAP Web UI.

  2. Browse to Settings → Services.

  3. Select the plus button next to Adapters, enter the desired name of the adapter and select the type, and then click the save icon.

  4. A skeleton JSON object of the Service Configuration for the adapter will be created and can be edited to match your environment.

    Service Configuration

  5. Save your final adapter Service Configuration. The adapter status can be confirmed from Settings → System → Adapters.

Additional Information